<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>kalman-cpp: FX Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/x-mathjax-config">
  MathJax.Hub.Config({
    extensions: ["tex2jax.js"],
    jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">kalman-cpp
   </div>
   <div id="projectbrief">Implementation of Kalman Filter in C++</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.2 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_f_x.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_f_x-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">FX Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="fx_8h_source.html">fx.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a55c1146952f7c792e9d0b73603427093"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_x.html#a55c1146952f7c792e9d0b73603427093">FX</a> (colvec(*f)(colvec &amp;x, colvec &amp;some_constants))</td></tr>
<tr class="memdesc:a55c1146952f7c792e9d0b73603427093"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor, create a mathematical function.  <a href="class_f_x.html#a55c1146952f7c792e9d0b73603427093">More...</a><br /></td></tr>
<tr class="separator:a55c1146952f7c792e9d0b73603427093"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adcbe426b544509f4e3d1b174d3a87c1e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_x.html#adcbe426b544509f4e3d1b174d3a87c1e">~FX</a> ()</td></tr>
<tr class="memdesc:adcbe426b544509f4e3d1b174d3a87c1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor, nothing happens here.  <a href="class_f_x.html#adcbe426b544509f4e3d1b174d3a87c1e">More...</a><br /></td></tr>
<tr class="separator:adcbe426b544509f4e3d1b174d3a87c1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99f9d802876f6726360ff8dd97349bab"><td class="memItemLeft" align="right" valign="top">mat&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_x.html#a99f9d802876f6726360ff8dd97349bab">JacobianAt</a> (colvec &amp;x, colvec &amp;some_constants)</td></tr>
<tr class="memdesc:a99f9d802876f6726360ff8dd97349bab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate the Jacobian at certain inputs.  <a href="class_f_x.html#a99f9d802876f6726360ff8dd97349bab">More...</a><br /></td></tr>
<tr class="separator:a99f9d802876f6726360ff8dd97349bab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54e5d98adac66b1f8e7fb7217b056ec9"><td class="memItemLeft" align="right" valign="top">mat&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_x.html#a54e5d98adac66b1f8e7fb7217b056ec9">HessianAt</a> (colvec &amp;x, colvec &amp;some_constants, int i)</td></tr>
<tr class="memdesc:a54e5d98adac66b1f8e7fb7217b056ec9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate the Hessian, at certain inputs.  <a href="class_f_x.html#a54e5d98adac66b1f8e7fb7217b056ec9">More...</a><br /></td></tr>
<tr class="separator:a54e5d98adac66b1f8e7fb7217b056ec9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1ef2f0229463d1a9d12ee2041972e12"><td class="memItemLeft" align="right" valign="top">colvec&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_x.html#ac1ef2f0229463d1a9d12ee2041972e12">SolveAt</a> (colvec &amp;x, colvec &amp;some_constants)</td></tr>
<tr class="memdesc:ac1ef2f0229463d1a9d12ee2041972e12"><td class="mdescLeft">&#160;</td><td class="mdescRight">Solve the function at certain inputs.  <a href="class_f_x.html#ac1ef2f0229463d1a9d12ee2041972e12">More...</a><br /></td></tr>
<tr class="separator:ac1ef2f0229463d1a9d12ee2041972e12"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af5dac6379cad0385dd26219bc9d184d7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_x.html#af5dac6379cad0385dd26219bc9d184d7">SetEpsilon</a> (double epsilon)</td></tr>
<tr class="memdesc:af5dac6379cad0385dd26219bc9d184d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">A very small number.  <a href="class_f_x.html#af5dac6379cad0385dd26219bc9d184d7">More...</a><br /></td></tr>
<tr class="separator:af5dac6379cad0385dd26219bc9d184d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a55c1146952f7c792e9d0b73603427093"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a55c1146952f7c792e9d0b73603427093">&#9670;&nbsp;</a></span>FX()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FX::FX </td>
          <td>(</td>
          <td class="paramtype">colvec(*)(colvec &amp;x, colvec &amp;some_constants)&#160;</td>
          <td class="paramname"><em>f</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Constructor, create a mathematical function. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">f</td><td>Address to the user defined mathematical function. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="adcbe426b544509f4e3d1b174d3a87c1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adcbe426b544509f4e3d1b174d3a87c1e">&#9670;&nbsp;</a></span>~FX()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FX::~FX </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Destructor, nothing happens here. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a54e5d98adac66b1f8e7fb7217b056ec9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a54e5d98adac66b1f8e7fb7217b056ec9">&#9670;&nbsp;</a></span>HessianAt()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">mat FX::HessianAt </td>
          <td>(</td>
          <td class="paramtype">colvec &amp;&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">colvec &amp;&#160;</td>
          <td class="paramname"><em>some_constants</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>i</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Calculate the Hessian, at certain inputs. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">x</td><td>Location where the Hessian is computed. </td></tr>
    <tr><td class="paramname">some_constants</td><td>Optional constants used in the function. </td></tr>
    <tr><td class="paramname">i</td><td>For a function of vector, do Hessian at i-th element of the vector. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Hessian at location x. </dd></dl>

</div>
</div>
<a id="a99f9d802876f6726360ff8dd97349bab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a99f9d802876f6726360ff8dd97349bab">&#9670;&nbsp;</a></span>JacobianAt()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">mat FX::JacobianAt </td>
          <td>(</td>
          <td class="paramtype">colvec &amp;&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">colvec &amp;&#160;</td>
          <td class="paramname"><em>some_constants</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Calculate the Jacobian at certain inputs. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">x</td><td>Location where the Jacobian is computed. </td></tr>
    <tr><td class="paramname">some_constants</td><td>Optional constants used in the function. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Jacobian at location x </dd></dl>

</div>
</div>
<a id="af5dac6379cad0385dd26219bc9d184d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5dac6379cad0385dd26219bc9d184d7">&#9670;&nbsp;</a></span>SetEpsilon()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void FX::SetEpsilon </td>
          <td>(</td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>epsilon</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>A very small number. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">epsilon</td><td>A very small number. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ac1ef2f0229463d1a9d12ee2041972e12"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1ef2f0229463d1a9d12ee2041972e12">&#9670;&nbsp;</a></span>SolveAt()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">colvec FX::SolveAt </td>
          <td>(</td>
          <td class="paramtype">colvec &amp;&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">colvec &amp;&#160;</td>
          <td class="paramname"><em>some_constants</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Solve the function at certain inputs. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">x</td><td>Location where the function is solved. </td></tr>
    <tr><td class="paramname">some_constants</td><td>Optional constants used in the function. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result from solving the function. </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>kalman/<a class="el" href="fx_8h_source.html">fx.h</a></li>
<li>kalman/<a class="el" href="fx_8cpp.html">fx.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="class_f_x.html">FX</a></li>
    <li class="footer">Generated on Thu Apr 1 2021 04:15:37 for kalman-cpp by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.2 </li>
  </ul>
</div>
</body>
</html>
